<html xmlns="http://www.w3.org/1999/xhtml"><head><title>DocBlox Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="css/jquery-ui.css" type="text/css"></link><link rel="stylesheet" href="css/docblox/jquery-ui-1.8.16.custom.css" type="text/css"></link><link rel="stylesheet" href="css/jquery.treeview.css" type="text/css"></link><link rel="stylesheet" href="css/theme.css" type="text/css"></link><script type="text/javascript" src="js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="js/jquery.cookie.js"></script><script type="text/javascript" src="js/jquery.treeview.js"></script><script type="text/javascript">
            $(document).ready(function() {
                $(".filetree").treeview({
                    collapsed: true,
                    persist: "cookie"
                });

                $("#accordion").accordion({
                    collapsible: true,
                    autoHeight:  false,
                    fillSpace:   true
                });

                $(".tabs").tabs();
            });
        </script></head><body><div xmlns="" id="content">
<script xmlns:dbx="http://docblox-project.org/xsl/functions">

      function filterElements()
      {
        inherited = !$('#show-inherited').hasClass('deselected');
        public    = !$('#show-public').hasClass('deselected');
        protected = !$('#show-protected').hasClass('deselected');
        private   = !$('#show-private').hasClass('deselected');

        $('div.public').each(function(index, val) {
            $(val).toggle(public && !($(val).hasClass('inherited_from') && !inherited));
        });
        $('div.protected').each(function(index, val) {
            $(val).toggle(protected && !($(val).hasClass('inherited_from') && !inherited));
        });
        $('div.private').each(function(index, val) {
            $(val).toggle(private && !($(val).hasClass('inherited_from') && !inherited));
        });
      }

      $(document).ready(function() {
        $('a.gripper').click(function() {
            $(this).nextAll('div.code-tabs').slideToggle();
            $(this).children('img').toggle();
            return false;
        });

        $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').css('cursor', 'pointer');

        $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').click(function() {
            $(this).parent().nextAll('div.code-tabs').slideToggle();
            $(this).parent().prevAll('a.gripper').children('img').toggle();
            return false;
        });

        $('div.code-tabs').hide();
        $('a.gripper').show();
        $('div.code-tabs:empty').prevAll('a.gripper').html('');

        $('#show-public, #show-protected, #show-private, #show-inherited')
            .css('cursor', 'pointer')
            .click(function(){
                $(this).toggleClass('deselected');
                if ($(this).hasClass('deselected')) {
                  $(this).fadeTo('fast', '0.4');
                } else {
                  $(this).fadeTo('fast', '1.0');
                }
                filterElements();
                return false;
            });
        $('#show-protected, #show-private').click();

        // add the sliding behaviour to the file navigation and show it
        // it is initially hidden for non-JS users.
        $("#file-nav-box").show().hover(function() {
            $("#file-nav-container").slideDown(400);
        }, function() {
            $("#file-nav-container").slideUp(400);
        });
      });

      
    </script><h1 xmlns:dbx="http://docblox-project.org/xsl/functions" class="file">\src\Utils\Graphics2D\DrawingPanes\DrawingPane.inc</h1>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" id="file-nav-box">
<div id="file-nav-options">
              Show:
              <img src="images/icons/visibility_public.png" id="show-public"><img src="images/icons/visibility_protected.png" id="show-protected"><img src="images/icons/visibility_private.png" id="show-private"><span class="attribute" id="show-inherited">inherited</span>
</div>
<div id="file-nav-container">
<ul id="file-nav"><li>
<a href="#classes"><img src="images/icons/class.png" height="14">
                          Classes
                      </a><ul><li><a href="#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDrawingPane">\Utils\Graphics2D\DrawingPanes\DrawingPane</a></li></ul>
</li></ul>
<div style="clear: left;"></div>
</div>
<div id="file-nav-tab">
              Table of Contents
          </div>
</div>
<a xmlns:dbx="http://docblox-project.org/xsl/functions" name="top" class="anchor"></a><a name="classes" class="anchor"></a><a xmlns:dbx="http://docblox-project.org/xsl/functions" id="\Utils\Graphics2D\DrawingPanes\DrawingPane" class="anchor"></a><h2 xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">\Utils\Graphics2D\DrawingPanes\DrawingPane<div class="to-top"><a href="#top">jump to top</a></div>
</h2>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">
<small class="package"><b>Package: </b>Default</small><p class="short-description">This class implements an abstract drawing pane.</p>
<div class="long-description">
</div>
<dl class="class-info">
<dt>Implements</dt>
<dd><a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane">\Utils\Graphics2D\DrawingPanes\IDrawingPane</a></dd>
<dt>Children</dt>
<dd><a href="db_src_Utils_Graphics2D_DrawingPanes_DomDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDomDrawingPane">\Utils\Graphics2D\DrawingPanes\DomDrawingPane</a></dd>
<dd><a href="db_src_Utils_Graphics2D_DrawingPanes_GdLibDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CGdLibDrawingPane">\Utils\Graphics2D\DrawingPanes\GdLibDrawingPane</a></dd>
<dd><a href="db_src_Utils_Graphics2D_DrawingPanes_ImageDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CImageDrawingPane">\Utils\Graphics2D\DrawingPanes\ImageDrawingPane</a></dd>
</dl>
<h3>Properties</h3>
<div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::$dimension" class="anchor"></a><div class="property protected">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">\Utils\Geom\Dimension
                 <span class="highlight">$dimension</span>= '0'
                </code><div class="description">
<p class="short-description">the dimension of the document</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Default value</strong><code>0</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd><a href="db_src_Utils_Geom_Dimension.html#%5CUtils%5CGeom%5CDimension">\Utils\Geom\Dimension</a></dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::$document" class="anchor"></a><div class="property public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public">mixed
                 <span class="highlight">$document</span>= 'null'
                </code><div class="description">
<p class="short-description">the wrapped document</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>mixed</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::$fillColor" class="anchor"></a><div class="property protected">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">\Utils\Color\Color
                 <span class="highlight">$fillColor</span>= 'null'
                </code><div class="description">
<p class="short-description">the current fill color of the drawing pane</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd><a href="db_src_Utils_Color_Color.html#%5CUtils%5CColor%5CColor">\Utils\Color\Color</a></dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::$fontColor" class="anchor"></a><div class="property protected">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">\Utils\Color\Color
                 <span class="highlight">$fontColor</span>= 'null'
                </code><div class="description">
<p class="short-description">the current font color of the drawing pane</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd><a href="db_src_Utils_Color_Color.html#%5CUtils%5CColor%5CColor">\Utils\Color\Color</a></dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::$fontFamily" class="anchor"></a><div class="property protected">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">string
                 <span class="highlight">$fontFamily</span>= 'null'
                </code><div class="description">
<p class="short-description">the current font family of the drawing pane</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>string</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::$fontSize" class="anchor"></a><div class="property protected">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">int
                 <span class="highlight">$fontSize</span>= 'null'
                </code><div class="description">
<p class="short-description">the current font size in pixels of the drawing pane</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>int</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::$strokeColor" class="anchor"></a><div class="property protected">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">\Utils\Color\Color
                 <span class="highlight">$strokeColor</span>= 'null'
                </code><div class="description">
<p class="short-description">the current stroke color of the drawing pane</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd><a href="db_src_Utils_Color_Color.html#%5CUtils%5CColor%5CColor">\Utils\Color\Color</a></dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::$strokeWidth" class="anchor"></a><div class="property protected">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">int
                 <span class="highlight">$strokeWidth</span>= '1'
                </code><div class="description">
<p class="short-description">the currect stroke width of the drawing pane</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Default value</strong><code>1</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>int</dd>
</dl>
</div>
<div class="clear"></div>
</div>
</div>
<h3>Methods</h3>
<div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::__construct()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">__construct</span><span class="nb-faded-text">(
          <a href="db_src_Utils_Geom_Dimension.html#%5CUtils%5CGeom%5CDimension">\Utils\Geom\Dimension</a> $dimension
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">This acts as the constructor of the class.</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$dimension</th>
<td><a href="db_src_Utils_Geom_Dimension.html#%5CUtils%5CGeom%5CDimension">\Utils\Geom\Dimension</a></td>
<td><em><p>the dimension of the document</p></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::drawEllipse()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">drawEllipse</span><span class="nb-faded-text">(
          <a href="db_src_Utils_Geom_Point.html#%5CUtils%5CGeom%5CPoint">\Utils\Geom\Point</a> $center, <a href="db_src_Utils_Geom_Dimension.html#%5CUtils%5CGeom%5CDimension">\Utils\Geom\Dimension</a> $dimension
          )
        </span>
        :
          <a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane">\Utils\Graphics2D\DrawingPanes\IDrawingPane</a></code><div class="description">
<span class="attribute">inherited</span><p class="short_description">This method draws an ellipse on the document.</p>
<small>Inherited from:
                    <a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane::drawEllipse()">\Utils\Graphics2D\DrawingPanes\IDrawingPane::drawEllipse()</a></small>
</div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$center</th>
<td><a href="db_src_Utils_Geom_Point.html#%5CUtils%5CGeom%5CPoint">\Utils\Geom\Point</a></td>
<td><em><p>the center of the ellipse</p></em></td>
</tr>
<tr>
<th>$dimension</th>
<td><a href="db_src_Utils_Geom_Dimension.html#%5CUtils%5CGeom%5CDimension">\Utils\Geom\Dimension</a></td>
<td><em><p>the dimension of the ellipse</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane">\Utils\Graphics2D\DrawingPanes\IDrawingPane</a></td>
<td>$this</td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::drawLine()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">drawLine</span><span class="nb-faded-text">(
          <a href="db_src_Utils_Geom_Point.html#%5CUtils%5CGeom%5CPoint">\Utils\Geom\Point</a> $source, <a href="db_src_Utils_Geom_Point.html#%5CUtils%5CGeom%5CPoint">\Utils\Geom\Point</a> $target
          )
        </span>
        :
          <a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane">\Utils\Graphics2D\DrawingPanes\IDrawingPane</a></code><div class="description">
<span class="attribute">inherited</span><p class="short_description">This method draws a line on the document.</p>
<small>Inherited from:
                    <a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane::drawLine()">\Utils\Graphics2D\DrawingPanes\IDrawingPane::drawLine()</a></small>
</div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$source</th>
<td><a href="db_src_Utils_Geom_Point.html#%5CUtils%5CGeom%5CPoint">\Utils\Geom\Point</a></td>
<td><em><p>the source point of the line</p></em></td>
</tr>
<tr>
<th>$target</th>
<td><a href="db_src_Utils_Geom_Point.html#%5CUtils%5CGeom%5CPoint">\Utils\Geom\Point</a></td>
<td><em><p>the target point of the line</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane">\Utils\Graphics2D\DrawingPanes\IDrawingPane</a></td>
<td>$this</td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::drawPolyLine()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">drawPolyLine</span><span class="nb-faded-text">(
          \Traversable $points
          )
        </span>
        :
          <a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane">\Utils\Graphics2D\DrawingPanes\IDrawingPane</a></code><div class="description"><p class="short_description">This method draws a poly line onto the the document.</p></div>
<div class="code-tabs">
<div class="long-description"><p>It expects an traversable of points, where each point is represented by a object of the class Point.</p>
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$points</th>
<td>\Traversable</td>
<td><em><p>the coordinates of the points of the line</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane">\Utils\Graphics2D\DrawingPanes\IDrawingPane</a></td>
<td>$this</td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::drawPolygon()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">drawPolygon</span><span class="nb-faded-text">(
          \Traversable $points
          )
        </span>
        :
          <a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane">\Utils\Graphics2D\DrawingPanes\IDrawingPane</a></code><div class="description">
<span class="attribute">inherited</span><p class="short_description">This method draws a polygon on the document.</p>
<small>Inherited from:
                    <a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane::drawPolygon()">\Utils\Graphics2D\DrawingPanes\IDrawingPane::drawPolygon()</a></small>
</div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$points</th>
<td>\Traversable</td>
<td><em><p>the points defining the polygon</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane">\Utils\Graphics2D\DrawingPanes\IDrawingPane</a></td>
<td>$this</td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::drawRectangle()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">drawRectangle</span><span class="nb-faded-text">(
          <a href="db_src_Utils_Geom_Point.html#%5CUtils%5CGeom%5CPoint">\Utils\Geom\Point</a> $topLeftCorner, <a href="db_src_Utils_Geom_Dimension.html#%5CUtils%5CGeom%5CDimension">\Utils\Geom\Dimension</a> $dimension
          )
        </span>
        :
          <a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane">\Utils\Graphics2D\DrawingPanes\IDrawingPane</a></code><div class="description">
<span class="attribute">inherited</span><p class="short_description">This method draws a rectangle on the document.</p>
<small>Inherited from:
                    <a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane::drawRectangle()">\Utils\Graphics2D\DrawingPanes\IDrawingPane::drawRectangle()</a></small>
</div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$topLeftCorner</th>
<td><a href="db_src_Utils_Geom_Point.html#%5CUtils%5CGeom%5CPoint">\Utils\Geom\Point</a></td>
<td><em><p>the top left corner of the rectangle</p></em></td>
</tr>
<tr>
<th>$dimension</th>
<td><a href="db_src_Utils_Geom_Dimension.html#%5CUtils%5CGeom%5CDimension">\Utils\Geom\Dimension</a></td>
<td><em><p>the dimension of the rectangle</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane">\Utils\Graphics2D\DrawingPanes\IDrawingPane</a></td>
<td>$this</td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::drawText()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">drawText</span><span class="nb-faded-text">(
          <a href="db_src_Utils_Geom_Point.html#%5CUtils%5CGeom%5CPoint">\Utils\Geom\Point</a> $topLeftCorner, \Utils\Graphics2D\DrawingPanes\type $text
          )
        </span>
        :
          <a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane">\Utils\Graphics2D\DrawingPanes\IDrawingPane</a></code><div class="description">
<span class="attribute">inherited</span><p class="short_description">This method draws text at the given position.</p>
<small>Inherited from:
                    <a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane::drawText()">\Utils\Graphics2D\DrawingPanes\IDrawingPane::drawText()</a></small>
</div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$topLeftCorner</th>
<td><a href="db_src_Utils_Geom_Point.html#%5CUtils%5CGeom%5CPoint">\Utils\Geom\Point</a></td>
<td><em><p>the top left corner of the text to draw</p></em></td>
</tr>
<tr>
<th>$text</th>
<td>\Utils\Graphics2D\DrawingPanes\type</td>
<td><em><p>the text to draw</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane">\Utils\Graphics2D\DrawingPanes\IDrawingPane</a></td>
<td>$this</td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::save()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">save</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          string</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">This method saves this DrawingPane to a string.</p>
<small>Inherited from:
                    <a href="db_src_Utils_Graphics2D_DrawingPanes_IDrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CIDrawingPane::save()">\Utils\Graphics2D\DrawingPanes\IDrawingPane::save()</a></small>
</div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::setFillColor()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setFillColor</span><span class="nb-faded-text">(
          <a href="db_src_Utils_Color_Color.html#%5CUtils%5CColor%5CColor">\Utils\Color\Color</a> $fillColor
          )
        </span>
        :
          <a href="db_src_Utils_Graphics2D_DrawingPanes_DrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDrawingPane">\Utils\Graphics2D\DrawingPanes\DrawingPane</a></code><div class="description"><p class="short_description">This method sets the fill color.</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$fillColor</th>
<td><a href="db_src_Utils_Color_Color.html#%5CUtils%5CColor%5CColor">\Utils\Color\Color</a></td>
<td><em><p>the new fill color</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_src_Utils_Graphics2D_DrawingPanes_DrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDrawingPane">\Utils\Graphics2D\DrawingPanes\DrawingPane</a></td>
<td>$this</td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::setFontColor()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setFontColor</span><span class="nb-faded-text">(
          <a href="db_src_Utils_Color_Color.html#%5CUtils%5CColor%5CColor">\Utils\Color\Color</a> $fontColor
          )
        </span>
        :
          <a href="db_src_Utils_Graphics2D_DrawingPanes_DrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDrawingPane">\Utils\Graphics2D\DrawingPanes\DrawingPane</a></code><div class="description"><p class="short_description">This method sets the font color.</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$fontColor</th>
<td><a href="db_src_Utils_Color_Color.html#%5CUtils%5CColor%5CColor">\Utils\Color\Color</a></td>
<td><em><p>the new font color</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_src_Utils_Graphics2D_DrawingPanes_DrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDrawingPane">\Utils\Graphics2D\DrawingPanes\DrawingPane</a></td>
<td>$this</td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::setFontFamily()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setFontFamily</span><span class="nb-faded-text">(
          string $fontFamily
          )
        </span>
        :
          <a href="db_src_Utils_Graphics2D_DrawingPanes_DrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDrawingPane">\Utils\Graphics2D\DrawingPanes\DrawingPane</a></code><div class="description"><p class="short_description">This method sets the font familiy.</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$fontFamily</th>
<td>string</td>
<td><em><p>the name of the new font family</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_src_Utils_Graphics2D_DrawingPanes_DrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDrawingPane">\Utils\Graphics2D\DrawingPanes\DrawingPane</a></td>
<td>$this</td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::setFontSize()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setFontSize</span><span class="nb-faded-text">(
          int $fontSize
          )
        </span>
        :
          <a href="db_src_Utils_Graphics2D_DrawingPanes_DrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDrawingPane">\Utils\Graphics2D\DrawingPanes\DrawingPane</a></code><div class="description"><p class="short_description">This method sets the font size.</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$fontSize</th>
<td>int</td>
<td><em><p>the new font size in pixel</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_src_Utils_Graphics2D_DrawingPanes_DrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDrawingPane">\Utils\Graphics2D\DrawingPanes\DrawingPane</a></td>
<td>$this</td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::setStrokeColor()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setStrokeColor</span><span class="nb-faded-text">(
          <a href="db_src_Utils_Color_Color.html#%5CUtils%5CColor%5CColor">\Utils\Color\Color</a> $strokeColor
          )
        </span>
        :
          <a href="db_src_Utils_Graphics2D_DrawingPanes_DrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDrawingPane">\Utils\Graphics2D\DrawingPanes\DrawingPane</a></code><div class="description"><p class="short_description">This method sets the stroke color.</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$strokeColor</th>
<td><a href="db_src_Utils_Color_Color.html#%5CUtils%5CColor%5CColor">\Utils\Color\Color</a></td>
<td><em><p>the new stroke color</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_src_Utils_Graphics2D_DrawingPanes_DrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDrawingPane">\Utils\Graphics2D\DrawingPanes\DrawingPane</a></td>
<td>$this</td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Utils\Graphics2D\DrawingPanes\DrawingPane::setStrokeWidth()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setStrokeWidth</span><span class="nb-faded-text">(
          int $strokeWidth
          )
        </span>
        :
          <a href="db_src_Utils_Graphics2D_DrawingPanes_DrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDrawingPane">\Utils\Graphics2D\DrawingPanes\DrawingPane</a></code><div class="description"><p class="short_description">This method sets the stroke width.</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$strokeWidth</th>
<td>int</td>
<td><em><p>the new stroke width</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_src_Utils_Graphics2D_DrawingPanes_DrawingPane.html#%5CUtils%5CGraphics2D%5CDrawingPanes%5CDrawingPane">\Utils\Graphics2D\DrawingPanes\DrawingPane</a></td>
<td>$this</td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
</div>
</div>
</div>
<small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.15.1</a>.
    </small></body></html>
